chore(orgs): Add section for invalid states #1676
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hey, here’s your docs preview: https://clerk.com/docs/pr/1676 |
LauraBeatris
force-pushed
the
organization-invalid-states
branch
from
ce23ba9 to
eb2fa9d
Compare
|
|
||
| ## Invalid states | ||
|
|
||
| Organizations can enter invalid states under certain conditions. Here are the common scenarios you should be aware of: |
There was a problem hiding this comment.
Suggested change
| Organizations can enter invalid states under certain conditions. Here are the common scenarios you should be aware of: | |
| Organizations can enter invalid states under certain conditions. |
we can either fully omit a second sentence, or have it like this:
Suggested change
| Organizations can enter invalid states under certain conditions. Here are the common scenarios you should be aware of: | |
| Organizations can enter invalid states under certain conditions. See the following sections for more information. |
I prefer the first.
victoriaxyz
reviewed
Dec 2, 2024
|
|
||
| ### Missing member with elevated permissions | ||
|
|
||
| An organization becomes invalid when it has no members with the following elevated permissions: `org:sys_memberships:read`, `org:sys_memberships:manage`, and `org:sys_profile:delete`. This typically occurs when removing the last admin or downgrading their role. |
There was a problem hiding this comment.
Just a nit for readability.
Suggested change
| An organization becomes invalid when it has no members with the following elevated permissions: `org:sys_memberships:read`, `org:sys_memberships:manage`, and `org:sys_profile:delete`. This typically occurs when removing the last admin or downgrading their role. | |
| An organization becomes invalid when it has no members with the following elevated permissions: `org:sys_memberships:read`, `org:sys_memberships:manage`, and `org:sys_profile:delete`. This typically occurs when the last admin is removed or their role is downgraded. |
|
@victoriaxyz @alexisintech Sorry for turning this into a draft again. I just want to make sure it isn't going to be merged just yet. This feature is behind a feature flag for testing in staging only, will be publishing the docs once it lands in production. I'll keep you updated! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Important
🔎 Previews:
Explanation:
This PR:
Resolves ORGS-284
Adds a section to clarify regarding organization invalid states. This could be linked to our upcoming Dashboard changes (https://github.com/clerk/dashboard/pull/3917)